Ambulance
Domain Message Specification

Version: 2.1; Status: Final

IncidentalLocation Tabular View

COCD_TP145014UK03
LocationRole
A template to detail a location which is associated with the patient's care, when the location is not somewhere that is a dedicated location for patient care. An example of this is the scene of a road traffic accident.
This class identifies the role which the location plays.
Used by:
[1..1] [M] classCode (CS { CNE: RoleClass } )
{ Fixed="ISDLOC" }

Model Attribute Description

The HL7 attribute classCode describes this class as an incidental service delivery location.

Implementation in XML Instance

The XML attribute classCode is fixed to " ISDLOC".
[0..1] addr (AD)

Model Attribute Description

The HL7 attribute uses an address for the place.

The HL7 attribute addr allows structured and unstructured addresses to be carried. Only a structured address is recommended to be used.

Implementation in XML Instance

There are a number of forms of structured address. The three shown here are the recommended formats for this address; they are listed in no particular order.

The XML element addr is populated as follows:

When using the structured address in the style of PDS the XML element addr shall contain five XML elements streetAddressLine.

  • The first XML element streetAddressLine shall contain the premises name
  • The second XML element streetAddressLine shall contain the number and thoroughfare
  • The third XML element streetAddressLine shall contain the locality
  • The fourth XML element streetAddressLine shall contain the post town
  • The fifth XML element streetAddressLine shall contain the county

The first XML element streetAddressLine or the second XML element streetAddressLine and the fourth XML element streetAddressLine are mandatory to be populated.

  • The XML element postalCode can be used to carry a postcode
  • The XML element addressKey can be used to carry a PAF key

When using the fully structured address format then the XML element addr shall be populated as follows:

  • The XML element houseNumber shall contain the house/building number or name
  • The XML element streetName shall contain the street name
  • The XML element city shall contain the city name
  • The XML element county shall contain the county
  • The XML element country shall contain the country name
  • The XML element postalCode shall contain the postcode
  • The XML element addressKey shall contain the address key

Note that unpopulated XML elements should not be present.

Alternatively the structured address may contain just a series of XML elements streetAddressLine populated in the correct order to render as a postal address with as much information as available included.

  • The first XML element streetAddressLine shall contain the first address line
  • The second XML element streetAddressLine shall contain the second address line
  • The third XML element streetAddressLine shall contain the third address line
  • and so on ....

Note that unpopulated XML elements should not be present.

The XML element addr also allows an XML attribute use and this should be used to further define the address type when required. Only the use values listed below are recommended to be used for this address.

Code
Definition
WP Work place - An office address. First choice for business related contacts during business hours.
TMP Temporary address - A temporary address; may be good for visit or mailing.
PHYS Physical visit address - Used primarily to visit an address.
H
 Home address - The person's home address; attempted contacts for business purposes might intrude privacy and chances are one will contact family or other household members instead of the person one wishes to call. Typically used with urgent cases, or if no other contacts are available.
HP
 The primary home address - An address to reach a person after business hours.
HV
 A vacation home - An address to reach a person while on vacation.

When the XML attribute use of the XML element addr contains the value "PHYS" then the following two XML elements of the XML element addr may be populated.

  • The XML element desc of the XML element addr may contain a description of the address; this may be used for things like directions for the address
  • The XML element additionalLocator of the XML element addr may contain additional location information such as longitude and latitude coordinates
[1..1] [M] code (CV { CNE:IncidentalLocationTypeSnCT } )
Model Attribute Description

The HL7 attribute code uses a code from the IncidentalLocationTypeSnCT vocabulary to describe the type of incidental service delivery location.

Implementation in XML Instance

The Coded Plain flavour of the Coded Value (CV) data type shall be used to carry this information in the XML element code as follows:

  • The XML attribute code shall contain the code from the IncidentalLocationTypeSnCT vocabulary
  • The XML attribute codeSystem shall contain the OID "2.16.840.1.113883.2.1.3.2.4.15"
  • The XML attribute displayName shall carry the description associated with the code in the IncidentalLocationTypeSnCT vocabulary
[0..1] telecom (TEL)

Model Attribute Description

The HL7 attribute telecom provides contact details for the incidental location in the form of telephone numbers, fax numbers and email addresses.

Implementation in XML Instance

This XML element telecom should be populated as below:

The XML attribute value of the XML element telecom should contain the telephone / fax number or an email address prefixed by the type of contact and a colon.

  • For a telephone number the actual telephone number would be prefixed with tel:
  • For a fax number the actual fax number would be prefixed with fax:
  • For an email address the actual email address would be prefixed with mailto:

The XML attribute use of the XML element telecom may be used to give further information about the type of contact details contained in the XML attribute value. Only the use values listed below are recommended for the contact details associated with the role:

Code Definition
AS Answering service - an automated answering machine used for less urgent cases and if the main purpose of contact is to leave a message or access an automated announcement.
EC
Emergency contact - A contact specifically designated to be used for emergencies. This is the first choice in emergencies, independent of any other use codes.

The XML element useablePeriod of XML element telecom may be used to indicate when the contact details given are valid, for example to indicate that a telephone number is only for office hours (9am to 5 pm). It can be used to indicate some of the following types of valid times:

  • A point in time when the contact details are valid
  • A start and end time
    • Just including hours and minutes to indicate opening hours
    • Using dates for indicating a contact is only for a certain period of time
  • A start time only to indicate when the contact details are valid from
  • An end time only to indicate that the contact details are only valid until a certain date
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145014UK03#LocationRole" }

Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:

  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145014UK03#LocationRole"
[0..1] location (Place)
A link to the place.
Place

Details of the actual place which is the location.

Note when this class is used at least one of either name or desc attributes shall be used.

Used by: LocationRole
[1..1] [M] classCode (CS { CNE: EntityClass } )
{ Fixed="PLC" }

Model Attribute Description

The HL7 attribute classCode describes this class as a place

Implementation in XML Instance

The XML attribute classCode is fixed to " PLC".
[1..1] [M] determinerCode (CS { CNE: EntityDeterminer } )
{ Fixed="INSTANCE" }

Model Attribute Description

The HL7 attribute determinerCode describes this class as an instance of a place.

Implementation in XML Instance

The XML attribute determinerCode is fixed to " INSTANCE".
[0..1] code (CS { CNE:PlaceEntityType } )

Model Attribute Description

The HL7 attribute code uses a code from the HL7 vocabulary PlaceEntityType to describe the type of place.

Implementation in XML Instance

The XML attribute code shall carry a value from the HL7 vocabulary PlaceEntityType.
[1..1] [R] desc (ST)

Model Attribute Description

The HL7 attribute desc is used when the place has a description rather than a name.

Implementation in XML Instance

The XML element desc shall contain a string which is the name of the place

When the description is not available, then the XML attribute nullFlavor of the XML element desc should carry the value "NI".

When the XML element name is used instead because the place has a name, then the XML attribute nullFlavor of the XML element desc should carry the value " NA".
[1..1] [R] name (TN)

Model Attribute Description

The HL7 attribute name is used when the place has a name.

Implementation in XML Instance

The XML element name shall contain a string which is the name of the place

When the name is not available, then the XML attribute nullFlavor of the XML element name should carry the value "NI".

When the XML element addr is used instead because the place has an address; then the XML attribute nullFlavor of the XML element name should carry the value "NA".
[1..1] [M] templateId (II)
{ Fixed="COCD_TP145014UK03#location" }
Model Attribute Description

The HL7 attribute templateId provides a unique identifier for the template and the class name within that template. This is used to identify how the CDA standard has been constrained for NHS use.

Implementation in XML Instance

The Identifier External data type flavour is used to carry this information in the XML element templateId as follows:
  • The XML attribute root is fixed to the OID "2.16.840.1.113883.2.1.3.2.4.18.2"
  • The XML attribute extension is fixed to "COCD_TP145014UK03#location"